StartNew(TResult) Method (Func(Object, TResult), Object, TaskCreationOptions)

Task Parallel System.Threading

previous page next page

Creates and starts a Task<(Of <(TResult>)>).

Namespace:  System.Threading.Tasks
Assembly:  System.Threading (in System.Threading.dll)

Syntax

Visual Basic (Declaration)
Public Function StartNew(Of TResult) ( _
	function As Func(Of Object, TResult), _
	state As Object, _
	creationOptions As TaskCreationOptions _
) As Task(Of TResult)
C#
public Task<TResult> StartNew<TResult>(
	Func<Object, TResult> function,
	Object state,
	TaskCreationOptions creationOptions
)

Parameters

function
Type: System..::.Func<(Of <(Object, TResult>)>)
A function delegate that returns the future result to be available through the Task<(Of <(TResult>)>).
state
Type: System..::.Object
An object containing data to be used by the function delegate.
creationOptions
Type: System.Threading.Tasks..::.TaskCreationOptions
A TaskCreationOptions value that controls the behavior of the created Task<(Of <(TResult>)>).

Type Parameters

TResult
The type of the result available through the Task.

Return Value

The started Task<(Of <(TResult>)>).

Remarks

Calling StartNew is functionally equivalent to creating a Task<(Of <(TResult>)>) using one of its constructors and then calling Start to schedule it for execution. However, unless creation and scheduling must be separated, StartNew is the recommended approach for both simplicity and performance.

Exceptions

ExceptionCondition
System..::.ArgumentNullExceptionThe exception that is thrown when the function argument is null.
System..::.ArgumentOutOfRangeExceptionThe exception that is thrown when the creationOptions argument specifies an invalid TaskCreationOptions value.

See Also

previous page start next page